<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Swift</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Swift</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Swift is the central component in the Swift library.</p>
	<ul class="tags">
				<li><span class="field">version:</span> 3.3.2</li>
				<li><span class="field">author:</span> Chris Corbyn &lt;<a href="mailto:chris@w3style.co.uk">chris@w3style.co.uk</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Swift.php.html">/Swift.php</a> (line <span class="field">38</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																																<div class="var-title">
					<span class="var-type"><a href="../Swift_Connection/Swift_Connection.html">Swift_Connection</a></span>
					<a href="#$connection" title="details" class="var-name">$connection</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$domain" title="details" class="var-name">$domain</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$ENABLE_LOGGING" title="details" class="var-name">$ENABLE_LOGGING</a>
				</div>
																<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$listeners" title="details" class="var-name">$listeners</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$NO_HANDSHAKE" title="details" class="var-name">$NO_HANDSHAKE</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$NO_POST_CONNECT" title="details" class="var-name">$NO_POST_CONNECT</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$NO_START" title="details" class="var-name">$NO_START</a>
				</div>
																<div class="var-title">
					<span class="var-type">int</span>
					<a href="#$options" title="details" class="var-name">$options</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																												
												<div class="method-definition">
											<span class="method-result">Swift</span>
										<a href="#Swift" title="details" class="method-name">Swift</a>
											(<span class="var-type"><a href="../Swift_Connection/Swift_Connection.html">Swift_Connection</a></span>&nbsp;<span class="var-name">&$conn</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span> = <span class="var-default">false</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#assertCorrectResponse" title="details" class="method-name">assertCorrectResponse</a>
											(<span class="var-type">Swift_Event_ResponseEvent</span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$codes</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#attachPlugin" title="details" class="method-name">attachPlugin</a>
											(<span class="var-type"><a href="../Swift_Events/Swift_Events_Listener.html">Swift_Events_Listener</a></span>&nbsp;<span class="var-name">&$plugin</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$id</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#batchSend" title="details" class="method-name">batchSend</a>
											(<span class="var-type"><a href="../Swift_Message/Swift_Message.html">Swift_Message</a></span>&nbsp;<span class="var-name">&$message</span>, <span class="var-type"><a href="../Swift/Swift_RecipientList.html">Swift_RecipientList</a></span>&nbsp;<span class="var-name">&$to</span>, <span class="var-type"><a href="../Swift/Swift_Address.html">Swift_Address</a></span>&nbsp;<span class="var-name">$from</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../Swift_Events/Swift_Events_ResponseEvent.html">Swift_Events_ResponseEvent</a></span>
										<a href="#command" title="details" class="method-name">&amp;command</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$command</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#connect" title="details" class="method-name">connect</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#disconnect" title="details" class="method-name">disconnect</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getOptions" title="details" class="method-name">getOptions</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">Swift_Event_Listener</span>
										<a href="#getPlugin" title="details" class="method-name">&amp;getPlugin</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#handshake" title="details" class="method-name">handshake</a>
											(<span class="var-type"><a href="../Swift_Events/Swift_Events_ResponseEvent.html">Swift_Events_ResponseEvent</a></span>&nbsp;<span class="var-name">&$greeting</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#hasOption" title="details" class="method-name">hasOption</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$option</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#initializeEventListenerContainer" title="details" class="method-name">initializeEventListenerContainer</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#notifyListeners" title="details" class="method-name">notifyListeners</a>
											(<span class="var-type"><a href="../Swift_Events/Swift_Events.html">Swift_Events</a></span>&nbsp;<span class="var-name">&$e</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removePlugin" title="details" class="method-name">removePlugin</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#reset" title="details" class="method-name">reset</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#send" title="details" class="method-name">send</a>
											(<span class="var-type"><a href="../Swift_Message/Swift_Message.html">Swift_Message</a></span>&nbsp;<span class="var-name">&$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$recipients</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$from</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setConnectionExtensions" title="details" class="method-name">setConnectionExtensions</a>
											(<span class="var-type"><a href="../Swift_Events/Swift_Events_ResponseEvent.html">Swift_Events_ResponseEvent</a></span>&nbsp;<span class="var-name">&$list</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setDomain" title="details" class="method-name">setDomain</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setOptions" title="details" class="method-name">setOptions</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$options</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$connection" id="$connection"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../Swift_Connection/Swift_Connection.html">Swift_Connection</a></span>
			<span class="var-name">$connection</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">60</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The connection object currently active</p>
	
	
		
		

</div>
<a name="var$domain" id="$domain"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$domain</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">65</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The domain name of this server (should technically be a FQDN)</p>
	
	
		
		

</div>
<a name="var$ENABLE_LOGGING" id="$ENABLE_LOGGING"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$ENABLE_LOGGING</span>
			 = <span class="var-default"> SWIFT_ENABLE_LOGGING</span>			(line <span class="line-number">51</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constant to ask Swift to start logging</p>
	
	
		
		

</div>
<a name="var$listeners" id="$listeners"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$listeners</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">75</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loaded plugins, separated into containers according to roles</p>
	
	
		
		

</div>
<a name="var$NO_HANDSHAKE" id="$NO_HANDSHAKE"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$NO_HANDSHAKE</span>
			 = <span class="var-default"> SWIFT_NO_HANDSHAKE</span>			(line <span class="line-number">47</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constant to tell Swift not to perform the standard SMTP handshake upon connect</p>
	
	
		
		

</div>
<a name="var$NO_POST_CONNECT" id="$NO_POST_CONNECT"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$NO_POST_CONNECT</span>
			 = <span class="var-default"> SWIFT_NO_POST_CONNECT</span>			(line <span class="line-number">55</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constant to prevent postConnect() being run in the connection</p>
	
	
		
		

</div>
<a name="var$NO_START" id="$NO_START"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$NO_START</span>
			 = <span class="var-default"> SWIFT_NO_START</span>			(line <span class="line-number">43</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constant to flag Swift not to try and connect upon instantiation</p>
	
	
		
		

</div>
<a name="var$options" id="$options"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$options</span>
						(line <span class="line-number">70</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Flags to change the behaviour of Swift</p>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodSwift" id="Swift"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor Swift</span> (line <span class="line-number">84</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
	<ul class="tags">
				<li><span class="field">throws:</span> Swift_ConnectionException If a connection cannot be established or the connection is behaving incorrectly</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Swift</span>
		<span class="method-name">
			Swift
		</span>
					(<span class="var-type"><a href="../Swift_Connection/Swift_Connection.html">Swift_Connection</a></span>&nbsp;<span class="var-name">&$conn</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span> = <span class="var-default">false</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Swift_Connection/Swift_Connection.html">Swift_Connection</a></span>
				<span class="var-name">&$conn</span><span class="var-description">: The connection object to deal with I/O</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$domain</span><span class="var-description">: The domain name of this server (the client) as a FQDN</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$options</span><span class="var-description">: Optional flags</span>			</li>
				</ul>
		
			
	</div>
<a name="methodassertCorrectResponse" id="assertCorrectResponse"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">assertCorrectResponse</span> (line <span class="line-number">252</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Throws an exception if the response code wanted does not match the one returned</p>
	<ul class="tags">
				<li><span class="field">throws:</span> Swift_BadResponseException If the code does not match</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			assertCorrectResponse
		</span>
					(<span class="var-type">Swift_Event_ResponseEvent</span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$codes</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Swift_Event_ResponseEvent</span>
				<span class="var-name">&$response</span><span class="var-description">: The full response from the service</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$codes</span><span class="var-description">: The 3 digit response code wanted</span>			</li>
				</ul>
		
			
	</div>
<a name="methodattachPlugin" id="attachPlugin"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">attachPlugin</span> (line <span class="line-number">129</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add a new plugin to Swift</p>
<p class="description"><p>Plugins must implement one or more event listeners</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			attachPlugin
		</span>
					(<span class="var-type"><a href="../Swift_Events/Swift_Events_Listener.html">Swift_Events_Listener</a></span>&nbsp;<span class="var-name">&$plugin</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Swift_Events/Swift_Events_Listener.html">Swift_Events_Listener</a></span>
				<span class="var-name">&$plugin</span><span class="var-description">: The plugin to load</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$id</span>			</li>
				</ul>
		
			
	</div>
<a name="methodbatchSend" id="batchSend"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">batchSend</span> (line <span class="line-number">545</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send a message to a batch of recipients.</p>
<p class="description"><p>Unlike send() this method ignores Cc and Bcc recipients and does not reveal every recipients' address in the headers</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The number of successful recipients</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			batchSend
		</span>
					(<span class="var-type"><a href="../Swift_Message/Swift_Message.html">Swift_Message</a></span>&nbsp;<span class="var-name">&$message</span>, <span class="var-type"><a href="../Swift/Swift_RecipientList.html">Swift_RecipientList</a></span>&nbsp;<span class="var-name">&$to</span>, <span class="var-type"><a href="../Swift/Swift_Address.html">Swift_Address</a></span>&nbsp;<span class="var-name">$from</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Swift_Message/Swift_Message.html">Swift_Message</a></span>
				<span class="var-name">&$message</span><span class="var-description">: The message to send (leave out the recipient headers unless you are deliberately overriding them)</span>			</li>
					<li>
				<span class="var-type"><a href="../Swift/Swift_RecipientList.html">Swift_RecipientList</a></span>
				<span class="var-name">&$to</span><span class="var-description">: The addresses to send to</span>			</li>
					<li>
				<span class="var-type"><a href="../Swift/Swift_Address.html">Swift_Address</a></span>
				<span class="var-name">$from</span><span class="var-description">: The address the mail is from (sender)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcommand" id="command"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">command</span> (line <span class="line-number">315</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Execute a command against the service and get the response</p>
	<ul class="tags">
				<li><span class="field">return:</span> The server's response (could be multiple lines)</li>
				<li><span class="field">throws:</span> Swift_ConnectionException If a code was expected but does not match the one returned</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Swift_Events/Swift_Events_ResponseEvent.html">Swift_Events_ResponseEvent</a></span>
		<span class="method-name">
			&amp;command
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$command</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$command</span><span class="var-description">: The command to execute (leave off any CRLF!!!)</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$code</span><span class="var-description">: The code to check for in the response, if any. -1 indicates that no response is wanted.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodconnect" id="connect"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">connect</span> (line <span class="line-number">224</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Attempt to establish a connection with the service</p>
	<ul class="tags">
				<li><span class="field">throws:</span> Swift_ConnectionException If the connection cannot be established or behaves oddly</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			connect
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methoddisconnect" id="disconnect"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">disconnect</span> (line <span class="line-number">239</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Disconnect from the MTA</p>
	<ul class="tags">
				<li><span class="field">throws:</span> Swift_ConnectionException If the connection will not stop</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			disconnect
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetOptions" id="getOptions"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getOptions</span> (line <span class="line-number">208</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the current options set (as bits)</p>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getOptions
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetPlugin" id="getPlugin"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getPlugin</span> (line <span class="line-number">146</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get an attached plugin if it exists</p>
	
	<div class="method-signature">
		<span class="method-result">Swift_Event_Listener</span>
		<span class="method-name">
			&amp;getPlugin
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span><span class="var-description">: The id of the plugin</span>			</li>
				</ul>
		
			
	</div>
<a name="methodhandshake" id="handshake"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">handshake</span> (line <span class="line-number">275</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Have a polite greeting with the server and work out what it's capable of</p>
	<ul class="tags">
				<li><span class="field">throws:</span> Swift_ConnectionException If conversation is not going very well</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			handshake
		</span>
					(<span class="var-type"><a href="../Swift_Events/Swift_Events_ResponseEvent.html">Swift_Events_ResponseEvent</a></span>&nbsp;<span class="var-name">&$greeting</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Swift_Events/Swift_Events_ResponseEvent.html">Swift_Events_ResponseEvent</a></span>
				<span class="var-name">&$greeting</span><span class="var-description">: The initial service line respoonse</span>			</li>
				</ul>
		
			
	</div>
<a name="methodhasOption" id="hasOption"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">hasOption</span> (line <span class="line-number">191</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check if an option flag has been set</p>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			hasOption
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$option</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$option</span><span class="var-description">: Option name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodinitializeEventListenerContainer" id="initializeEventListenerContainer"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">initializeEventListenerContainer</span> (line <span class="line-number">115</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Populate the listeners array with the defined listeners ready for plugins</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			initializeEventListenerContainer
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodnotifyListeners" id="notifyListeners"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">notifyListeners</span> (line <span class="line-number">174</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send a new type of event to all objects which are listening for it</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			notifyListeners
		</span>
					(<span class="var-type"><a href="../Swift_Events/Swift_Events.html">Swift_Events</a></span>&nbsp;<span class="var-name">&$e</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Swift_Events/Swift_Events.html">Swift_Events</a></span>
				<span class="var-name">&$e</span><span class="var-description">: The event to send</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$type</span><span class="var-description">: The type of event</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremovePlugin" id="removePlugin"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">removePlugin</span> (line <span class="line-number">159</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove a plugin attached under the ID of $id</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removePlugin
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span><span class="var-description">: The ID of the plugin</span>			</li>
				</ul>
		
			
	</div>
<a name="methodreset" id="reset"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">reset</span> (line <span class="line-number">349</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reset a conversation which has gone badly</p>
	<ul class="tags">
				<li><span class="field">throws:</span> Swift_ConnectionException If the service refuses to reset</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			reset
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsend" id="send"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">send</span> (line <span class="line-number">361</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send a message to any number of recipients</p>
	<ul class="tags">
				<li><span class="field">return:</span> The number of successful recipients</li>
				<li><span class="field">throws:</span> Swift_ConnectionException If sending fails for any reason.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			send
		</span>
					(<span class="var-type"><a href="../Swift_Message/Swift_Message.html">Swift_Message</a></span>&nbsp;<span class="var-name">&$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$recipients</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$from</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Swift_Message/Swift_Message.html">Swift_Message</a></span>
				<span class="var-name">&$message</span><span class="var-description">: The message to send.  This does not need to (and shouldn't really) have any of the recipient headers set.</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$recipients</span><span class="var-description">: The recipients to send to.  Can be a string, Swift_Address or Swift_RecipientList. Note that all addresses apart from Bcc recipients will appear in the message headers</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$from</span><span class="var-description">: The address to send the message from.  Can either be a string or an instance of Swift_Address.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetConnectionExtensions" id="setConnectionExtensions"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setConnectionExtensions</span> (line <span class="line-number">292</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the extensions which the service reports in the connection object</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setConnectionExtensions
		</span>
					(<span class="var-type"><a href="../Swift_Events/Swift_Events_ResponseEvent.html">Swift_Events_ResponseEvent</a></span>&nbsp;<span class="var-name">&$list</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Swift_Events/Swift_Events_ResponseEvent.html">Swift_Events_ResponseEvent</a></span>
				<span class="var-name">&$list</span><span class="var-description">: The list of extensions as reported by the service</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetDomain" id="setDomain"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setDomain</span> (line <span class="line-number">216</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the FQDN of this server as it will identify itself</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setDomain
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: The FQDN of the server</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetOptions" id="setOptions"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setOptions</span> (line <span class="line-number">200</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adjust the options flags</p>
<p class="description"><p>E.g. $obj-&gt;setOptions(Swift::NO_START | Swift::NO_HANDSHAKE)</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setOptions
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$options</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$options</span><span class="var-description">: The bits to set</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Wed, 26 Mar 2008 20:33:52 +1100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.1</a>
	</p>
	</div></body>
</html>